<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: /bb/mbigc/mbig5696/git/quantum_external/src/quantum_capture.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('dd/d52/quantum__capture_8h_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">quantum_capture.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">** Copyright 2018 Bloomberg Finance L.P.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">** Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">** you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">** You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">**     http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">** Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">** distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">** See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">** limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef BLOOMBERG_QUANTUM_CAPTURE_H</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define BLOOMBERG_QUANTUM_CAPTURE_H</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;quantum/impl/quantum_stl_impl.h&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;quantum/quantum_traits.h&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;quantum/quantum_allocator_traits.h&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;assert.h&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &lt;tuple&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;array&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a> {</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">namespace </span>quantum {</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">//                                   class Capture</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"></span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> FUNC, <span class="keyword">typename</span> ... ARGS&gt;</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="../../db/dda/classBloomberg_1_1quantum_1_1Capture.html">   38</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../db/dda/classBloomberg_1_1quantum_1_1Capture.html">Capture</a></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;{</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <a class="code" href="../../db/dda/classBloomberg_1_1quantum_1_1Capture.html#acdefbd588c431b5d5cccb314c27792d2">Capture</a>(FUNC&amp;&amp; func, ARGS&amp;&amp;...args);</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> ... T&gt;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../db/dda/classBloomberg_1_1quantum_1_1Capture.html#aedbc6d1a887277162097ccd7e734a988">operator()</a>(T&amp;&amp;...t);</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    FUNC                _func;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    std::tuple&lt;ARGS...&gt; _args;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;};</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">//Helper function</span></div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> FUNC, <span class="keyword">typename</span> ... ARGS&gt;</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<a class="code" href="../../db/dda/classBloomberg_1_1quantum_1_1Capture.html">Capture</a>&lt;FUNC, ARGS...&gt;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<a class="code" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0ddddf38209f4add2a3784f4e7c3d425">makeCapture</a>(FUNC&amp;&amp; func, ARGS&amp;&amp; ... args);</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">//                                   class Function</span></div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"></span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> RET, <span class="keyword">typename</span> ... ARGS&gt;</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">   62</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> RET, <span class="keyword">typename</span> ... ARGS&gt;</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="../../d6/dea/classBloomberg_1_1quantum_1_1Function_3_01RET_07ARGS_8_8_8_08_4.html">   65</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>&lt;RET(ARGS...)&gt;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;{</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <span class="keyword">static</span> constexpr <span class="keywordtype">size_t</span> size{__QUANTUM_FUNCTION_ALLOC_SIZE};</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <span class="keyword">using</span> Func = RET(*)(ARGS...);</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keyword">using</span> Callback = RET(*)(<span class="keywordtype">void</span>*, ARGS...);</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="keyword">using</span> Deleter = void(*)(<span class="keywordtype">void</span>*);</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    </div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="comment">// Ctors</span></div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>(RET(*ptr)(ARGS...)); <span class="comment">//construct with function pointer</span></div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> FUNCTOR&gt;</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>(FUNCTOR&amp;&amp; functor); <span class="comment">//construct with functor</span></div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>(<span class="keyword">const</span> <a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>&lt;RET(ARGS...)&gt;&amp; other);</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>(<a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>&lt;RET(ARGS...)&gt;&amp;&amp; other);</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    <a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>&lt;RET(ARGS...)&gt;&amp; other);</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>&amp; operator=(<a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>&lt;RET(ARGS...)&gt;&amp;&amp; other);</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    ~<a class="code" href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Function</a>();</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    </div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="comment">// Methods</span></div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    RET operator()(ARGS...args);</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    <span class="keyword">explicit</span> <span class="keyword">operator</span> bool() <span class="keyword">const</span>;</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    </div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    <span class="keyword">static</span> <span class="keywordtype">void</span> dummyDeleter(<span class="keywordtype">void</span>*) {}</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    <span class="keyword">static</span> <span class="keywordtype">void</span> deleter(<span class="keywordtype">void</span>* p) { <span class="keyword">delete</span>[] static_cast&lt;char*&gt;(p); }</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    </div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> FUNCTOR&gt;</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="keywordtype">void</span> initFunctor(FUNCTOR&amp;&amp; functor, std::true_type);</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    </div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> FUNCTOR&gt;</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    <span class="keywordtype">void</span> initFunctor(FUNCTOR&amp;&amp; functor, std::false_type);</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    </div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    std::array&lt;char, size&gt;  _storage;</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    <span class="keywordtype">void</span>*                   _callable;</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    Callback                _callback;</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    Deleter                 _deleter;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;};</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;}}</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="preprocessor">#include &lt;quantum/impl/quantum_capture_impl.h&gt;</span></div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="preprocessor">#endif //BLOOMBERG_QUANTUM_CAPTURE_H</span></div><div class="ttc" id="namespaceBloomberg_html"><div class="ttname"><a href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></div><div class="ttdef"><b>Definition:</b> quantum_buffer_impl.h:22</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Capture_html_acdefbd588c431b5d5cccb314c27792d2"><div class="ttname"><a href="../../db/dda/classBloomberg_1_1quantum_1_1Capture.html#acdefbd588c431b5d5cccb314c27792d2">Bloomberg::quantum::Capture::Capture</a></div><div class="ttdeci">Capture(FUNC &amp;&amp;func, ARGS &amp;&amp;...args)</div><div class="ttdef"><b>Definition:</b> quantum_capture_impl.h:29</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Capture_html_aedbc6d1a887277162097ccd7e734a988"><div class="ttname"><a href="../../db/dda/classBloomberg_1_1quantum_1_1Capture.html#aedbc6d1a887277162097ccd7e734a988">Bloomberg::quantum::Capture::operator()</a></div><div class="ttdeci">int operator()(T &amp;&amp;...t)</div><div class="ttdef"><b>Definition:</b> quantum_capture_impl.h:36</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Function_html"><div class="ttname"><a href="../../d7/d56/classBloomberg_1_1quantum_1_1Function.html">Bloomberg::quantum::Function</a></div><div class="ttdoc">Similar implementation to std::function except that it allows capture of non-copyable types.</div><div class="ttdef"><b>Definition:</b> quantum_capture.h:62</div></div>
<div class="ttc" id="namespaceBloomberg_1_1quantum_html_a0ddddf38209f4add2a3784f4e7c3d425"><div class="ttname"><a href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0ddddf38209f4add2a3784f4e7c3d425">Bloomberg::quantum::makeCapture</a></div><div class="ttdeci">Capture&lt; FUNC, ARGS... &gt; makeCapture(FUNC &amp;&amp;func, ARGS &amp;&amp;... args)</div><div class="ttdef"><b>Definition:</b> quantum_capture_impl.h:42</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Capture_html"><div class="ttname"><a href="../../db/dda/classBloomberg_1_1quantum_1_1Capture.html">Bloomberg::quantum::Capture</a></div><div class="ttdoc">Class allowing lambda parameter captures.</div><div class="ttdef"><b>Definition:</b> quantum_capture.h:38</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>quantum_capture.h</b></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
